I hope you find this help sheet useful I find documentation very hard to do.
This program aids in the creation of Records of Achievement.
Clicking on the "i" will display this help text.
It needs two input files - A file of type "RoA" see later for formats
A file of type "CSV" containing student data
Operation is fairly straight forward, drag the required files to the window
and they appear in the appropriate boxes. To change files, drag new files to
the window. The application supports dragging from save boxes, ie without
saving directly. Useful if you wish to print a selection of details from a
database.
PRINTING
********
Ensure a suitable printer driver is selected then click on -
"Create RoA" to produce RoAs.
"Staff Listing" to produce your reference listing, small gaps only.
The next window is self explanatory.
STATEMENT DATAFILE
******************
This datafile, of type "RoA" contains all the raw data. It was written for
a laser printer, but could be easily altered for another printer.
It is handled by MessageTrans so is similar format to that. Note if you wish % you must type %%.
Anything after a # is treated as a comment and lines commencing with a "#" are treated as comment lines.
The start of the datafile is a header as follows, the part before the ":" is a token used to call the value, the part after ":" is a
value used by the program. Then come the full descriptors used to
creating the RoA, each one preceded by a token. Various variables
are allowed, see list afterwards.
The tokens are case sensitive, and spaces are significant, however do not spaces at the start of lines, or immediately before the ":", as the program strips them off the student datafile, see below.:-
TY: # DM for dot matrix printer, LJ for laser printer.
CI:12# Characters per inch, 10,12,15,16.66,20
ST: 1# Style 0=straight 1=italic
WT: 0# Weight 0:medium 1-7 for bold
AM: 5# Absolute margin in cm, ie minimum possible
LM: 0# Size of left margin in cm, added to AM
IM: 1# Size of indent margin for carry on lines in cm, added to AM
NM: 0# Size of names margin in cm, added to AM
LL:10.5# Length of line in cm, added to AM
TM: 2# Top margin in cm to name details
MM: 8.25# Middle margin in cm to teacher comment, added to TM
FF:56# Line count force form feed teacher copy, not enough room next student
MD:30# Maximum descriptors, at least highest number
TR:??# What comes at top right, DATE in capitals if date
HE:??# A header message comes after middle margin. Use @cr@ etc. <250 chars
FO:??# Footer as for header. <250 characters
1: @name@ has attended all lessons.@cr@
4: @name@ has missed many lessons,this has affected @his@ progress.@cr@
6: @he@ always has @his@ exercise book.@cr@
9: @he@ rarely has @his@ exercise book.@cr@
11: All homeworks have been completed to a good standard.@cr@
22: @name@ has received two merits for good work in IT.@cr@
23: @name@ has received one merit for good work in IT.@cr@
Variables, all in lower case.
@name@ forename
@sname@ surname
@he@ or @she@ he/she
@his@ @her@ his/her
@cr@ cr/lf
@p@ will add an 's' if the first parameter greater than 1 eg merit@p@ will put merit or merits
@sp@ will add a space, used for the end of a statement.
: a line starting with a ":" is added as a general comment
%0 %1 %2 %3 are used for parameter passing in the statements.
44: @name@ gained %0%% in test 1 and %1%% in test 2.
STUDENT DATAFILE
****************
A CSV file of the student data. Currently the first four fields must be
Form, Surname, Forename, Gender. The fields are placed on the top of the RoA
in the order Forename Surname Form and date right justified.
Following is the descriptors in the following form :-
7A,"BLOGGS","FREDA",FEMALE,1# <=1 away., 6# always has., 11# good standard.,
25#Excellent, 21# 3 merits.,:A random comment
Only the number part is used, everything after the "#" is ignored.
UP TO 4 PARAMETERS SEPERATED BY : may be added.
44:54:43 would convert above into = gained 54% in test 1 and 43% in test 2.
: only allows random comment
TECHNICAL DETAILS
*****************
The facility to save from save boxes means that there must be a valid
<Wimp$Scrap>. The following files are created during this process "RoA_CSV"
and/or "RoA_Text". They will normally be correctly deleted afterwards.
The program has it's own file type, if this clashes with an existing one,
you will need to modify !Boot & !Run.
Versions
********
1.20 June 94 Header & footer added.
1.21 July 94 TY for printer added, # comment added
1.22 July 94 Force new page added for teacher list
